/*
 * Copyright (c) 2008, Roman Bosak
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  - Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *  - Neither the name of the DailyDevelopment nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.dailydev.jira.portal;

import java.util.Map;

import com.atlassian.jira.portal.PortalManager;
import com.atlassian.jira.portal.PortalPageConfiguration;
import com.atlassian.jira.portal.PortletConfigurationException;
import com.dailydev.jira.portal.config.IPortalPageSharingConfiguration;
import com.opensymphony.user.User;

/**
 * Interface extending standard Jira {@link PortalManager} interface with new
 * functionality related to portal page sharing.
 * 
 * @author Roman Bosak, roman.bosak@gmail.com
 */
public interface IDashboardSharingPortalManager extends PortalManager {

    /**
     * Returns instance of {@link IPortalPageSharingConfiguration} representing
     * configurations of portal page sharing.
     * 
     * @return instance of {@link IPortalPageSharingConfiguration} representing
     *         configurations of portal page sharing
     */
    IPortalPageSharingConfiguration getConfiguration();

    /**
     * Returns {@link Map} containing {@link PortalPageConfiguration}s owned
     * (authored) by <code>user</code> mapped to IDs of the pages.
     * 
     * @param user
     *            user whose authored portal pages we want to retrieve
     * @return {@link Map} containing {@link PortalPageConfiguration}s owned
     *         (authored) by <code>user</code> mapped to IDs of the pages.
     * @throws PortletConfigurationException
     *             if there are some problem with portal page configuration or
     *             it's storage
     */
    Map < Long, PortalPageConfiguration > getOwnPortalPageConfigurations(
            User user) throws PortletConfigurationException;

    /**
     * Returns {@link Map} containing {@link PortalPageConfiguration}s shared
     * for the <code>user</code> mapped to IDs of the pages.
     * 
     * @param user
     *            user for who we want to get shared portal pages
     * @return {@link Map} containing {@link PortalPageConfiguration}s shared
     *         for the <code>user</code> mapped to IDs of the pages.
     * @throws PortletConfigurationException
     *             if there are some problem with portal page configuration or
     *             it's storage
     */
    Map < Long, PortalPageConfiguration > getSharedPortalPageConfigurations(
            User user) throws PortletConfigurationException;
}
